Watchlist Screening
The Watchlist Screening capability screens users against global and regional sanctions and watchlists, PEPs.
Prerequisite
The Creating or Updating Accounts request body may include a WatchlistScreening object that includes a searchProfile. If used this value will override the default value configured in the Watchlist Screening settings. Consult your Jumio Account Manager for additional information.
Example WatchlistScreening Object
"capabilities":{
"watchlistScreening": {
"searchProfile": "abcd1234-xx11-yy22-zz33-a1b2-a1b2c3d4e5f6"
}
}
Dependencies
Watchlist Screening is typically used with the ID or IDIV services. In those situations, the required data is extracted from the uploaded ID credential, which requires these capabiities:
Prepared Data
Watchlist Screening can also be used as a standalone service by providing the following values as Prepared Data:
|
Key |
Type |
Mandatory |
Description |
|---|---|---|---|
|
address.country |
string |
Yes |
Country should be ISO Alpha 3 Code only. |
|
dateOfBirth |
string |
Yes |
Date of birth in yyyy-MM-dd format only. |
|
firstName |
string |
Yes |
End user's first name. |
|
kyc.registrationDate |
string |
Conditional |
Customer registration date in yyyy-MM-dd format only. Required only if execution is done via 4Stop. |
|
kyc.registrationIpAddress |
string |
Conditional |
IPv4 or IPv6 formats are allowed. Required if execution done via 4Stop only. |
|
lastName |
string |
Yes |
End user's last name. |
Decision Details Labels
|
Decision Type |
Label |
Description |
|---|---|---|
|
NOT_EXECUTED |
PRECONDITION_NOT_FULFILLED |
Required data from another capability is not available. |
|
NOT_EXECUTED |
TECHNICAL_ERROR |
An error prevented execution. |
|
NOT_EXECUTED |
NOT_ENOUGH_DATA |
|
|
NOT_EXECUTED |
VALIDATION_FAILED |
|
|
NOT_EXECUTED |
INVALID_MERCHANT_SETTINGS |
|
|
NOT_EXECUTED |
NO_VALID_ID_CREDENTIAL |
|
|
NOT_EXECUTED |
EXTRACTION_NOT_DONE |
|
|
PASSED |
OK |
The end user was not found on any watchlists. |
|
WARNING |
ALERT |
The end user was found on one or more watchlists. |
Data
|
Key |
Type |
Description |
|---|---|---|
|
searchDate |
string |
Timestamp (UTC) of the response. Format: YYYY-MM-DDThh:mm:ss.SSSZ |
|
searchStatus |
string |
Possible values:
|
|
searchId |
string |
Only if searchStatus = SUCCESS |
|
searchReference |
string |
Only if searchStatus = SUCCESS |
|
searchResultUrl |
string |
Only if searchStatus = SUCCESS |
|
searchResults |
integer |
Only if searchStatus = SUCCESS |